Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: Adding some clarifications for Optimize usage with OpenSearch #4430

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

feat: Adding some clarifications for Optimize usage with OpenSearch #4430

wants to merge 1 commit into from
+11 −25

Conversation

grlimacan
Copy link
Contributor

Description

Adding some clarifications for Optimize usage with OpenSearch

closes https://github.com/camunda/camunda-optimize/issues/14043

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@grlimacan grlimacan self-assigned this Oct 8, 2024
@grlimacan grlimacan added component:optimize Issues related with Optimize project deploy Stand up a temporary docs site with this PR labels Oct 8, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 8, 2024 •
edited
Loading

👋 🤖 🤔 Hello! Did you make your changes in all the right places?

These files were changed only in versioned_docs/version-8.6/. You might want to duplicate these changes in docs/.

  • versioned_docs/version-8.6/reference/supported-environments.md

You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines.

@engineering-issue-sync-app engineering-issue-sync-app bot mentioned this pull request Oct 8, 2024
Open
9 tasks
@grlimacan grlimacan force-pushed the optimize-14043-additional-opensearch-docs branch 2 times, most recently from 4b53bc9 to 13c1a41 Compare October 8, 2024 12:03
@grlimacan grlimacan marked this pull request as draft October 8, 2024 12:04
@grlimacan grlimacan force-pushed the optimize-14043-additional-opensearch-docs branch from 13c1a41 to 1d81314 Compare October 8, 2024 13:41
@grlimacan grlimacan force-pushed the optimize-14043-additional-opensearch-docs branch from 1d81314 to 946fb0a Compare October 8, 2024 13:43
@github-actions github-actions bot temporarily deployed to camunda-docs October 8, 2024 14:05 Destroyed
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 8, 2024

The preview environment relating to the commit e8db06f has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-4430/index.html

PHWaechtler
PHWaechtler requested changes Oct 9, 2024
View reviewed changes
Copy link
Contributor

@PHWaechtler PHWaechtler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just one small suggestion and the link that currently doesnt resolve properly in the preview env

versioned_docs/version-8.6/reference/supported-environments.md
| Connectors | OpenJDK 21+ | |
| Web Modeler | - | PostgreSQL 13.x, 14.x, 15.x, 16.x or Amazon Aurora PostgreSQL 13.x, 14.x, 15.x, 16.x |

- Not all Optimize features are supported when using OpenSearch as a database. For a full list of the features that are currently supported, please refer to the [Camunda 8](https://github.com/camunda/issues/issues/635) OpenSearch features.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this supposed to be referring to the asterisk in the table? If so lets add another *

docs/self-managed/setup/install.md

Refer to the [Operate](/self-managed/operate-deployment/operate-configuration.md#settings-for-opensearch) and [Tasklist](/self-managed/tasklist-deployment/tasklist-configuration.md#elasticsearch-or-opensearch) configuration documentation for additional component configuration parameters to update.
Refer to the [Operate](/self-managed/operate-deployment/operate-configuration.md#settings-for-opensearch), [Tasklist](/self-managed/tasklist-deployment/tasklist-configuration.md#elasticsearch-or-opensearch) and [Optimize](optimize/self-managed/optimize-deployment/configuration/system-configuration/#opensearch) configuration documentation for additional component configuration parameters to update.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This Optimize link doesnt work (it resolves to
https://preview.docs.camunda.cloud/pr-4430/docs/next/self-managed/setup/install/optimize/self-managed/optimize-deployment/configuration/system-configuration/#opensearch)

Copy link
Member

@akeller akeller Oct 9, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/camunda/camunda-docs/blob/main/howtos/documentation-guidelines.md#internal-links

If the source is in docs and the target is in optimize, use the $optimize$ token to prefix the URL.

versioned_docs/version-8.6/self-managed/setup/install.md

Refer to the [Operate](/self-managed/operate-deployment/operate-configuration.md#settings-for-opensearch) and [Tasklist](/self-managed/tasklist-deployment/tasklist-configuration.md#elasticsearch-or-opensearch) configuration documentation for additional component configuration parameters to update.
Refer to the [Operate](/self-managed/operate-deployment/operate-configuration.md#settings-for-opensearch), [Tasklist](/self-managed/tasklist-deployment/tasklist-configuration.md#elasticsearch-or-opensearch) and [Optimize](optimize/self-managed/optimize-deployment/configuration/system-configuration/#opensearch) configuration documentation for additional component configuration parameters to update.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Optimize link doesnt work (it resolves to
https://preview.docs.camunda.cloud/pr-4430/docs/next/self-managed/setup/install/optimize/self-managed/optimize-deployment/configuration/system-configuration/#opensearch)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@akeller akeller akeller left review comments

@PHWaechtler PHWaechtler PHWaechtler requested changes

Requested changes must be addressed to merge this pull request.

Assignees

@grlimacan grlimacan

Labels
component:optimize Issues related with Optimize project deploy Stand up a temporary docs site with this PR
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@grlimacan @akeller @PHWaechtler